Skip to content

docs(readme): add the web-to-web-page demo and caption both videos - #2344

Merged
AnishSarkar22 merged 1 commit into
MODSetter:devfrom
AnishSarkar22:docs/readme-demo-videos
Oct 25, 2026
Merged

AnishSarkar22 merged 1 commit into
MODSetter:devfrom
AnishSarkar22:docs/readme-demo-videos

Conversation

@AnishSarkar22

@AnishSarkar22 AnishSarkar22 commented Oct 25, 2026 •

Copy link
Copy Markdown
Collaborator

What

  • Adds a second demo video under the README header: Add from the web adding sources, then the agent turning them into an HTML web page.
  • Gives each video a short bold caption above it:
    • Redline a contract with tracked changes and comments
    • Add sources from the web, then turn them into a web page
  • Makes the same change in all ten README.<locale>.md files, with the captions translated in each README's own terms (its format table's word for "web page", its Word row's term for tracked changes, the app's word for "sources").
  • Updates the note at the top of README.md and plans/community-local/seo/06-repo-readme.md to describe two videos.

Why

The README showed only the editing demo. The second video shows the research side: finding sources on the web and turning them into a page.

The captions sit above the videos rather than below because the videos are stacked: a caption under the first would read as the title of the second. They're bold lines, not headings, so they don't add entries to GitHub's outline above the README's first section.

Fixes #

No linked issue.

How to test

  1. Open the branch's README.md on GitHub. Both videos play inline, each under its caption.
  2. Open two or three translations, such as README.de.md and README.ja.md, and check the same layout with translated captions.
  3. python scripts/check_docs.py

High-level PR Summary

This PR enhances the README documentation by adding a second demo video showcasing the research feature where users can add sources from the web and convert them into a web page. Both videos now include descriptive bold captions above them. The changes are applied consistently across all ten localized README files, with captions translated appropriately for each locale. The documentation note in plans/community-local/seo/06-repo-readme.md is also updated to reflect the two-video structure.

⏱️ Estimated Review Time: 5-15 minutes

💡 Review Order Suggestion
Order File Path
1 README.md
2 plans/community-local/seo/06-repo-readme.md
3 README.de.md
4 README.fr.md
5 README.es.md
6 README.pt-BR.md
7 README.ru.md
8 README.zh-CN.md
9 README.ja.md
10 README.ko.md
11 README.hi.md
12 README.ar.md

Need help? Join our Discord

A second demo shows Add from the web followed by an HTML web page. Each
video gets a bold caption above it, translated in every README, since a
caption below one would read as the title of the next.
@vercel

vercel Bot commented Oct 25, 2026

Copy link
Copy Markdown

@AnishSarkar22 is attempting to deploy a commit to the Rohan Verma's projects Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitai Bot commented Oct 25, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Caution

Review failed

The pull request is closed.

Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@AnishSarkar22
AnishSarkar22 merged commit f151dec into MODSetter:dev Oct 25, 2026
20 of 23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant